EditController Class Reference
[VST Implementation Helper Classes]

Default implementation for a VST 3 edit controller. More...

#include <vsteditcontroller.h>

Inheritance diagram for EditController:
Inheritance graph
[legend]

Public Member Functions

 EditController ()
virtual tresult setComponentState (IBStream *state)
virtual tresult setState (IBStream *state)
virtual tresult getState (IBStream *state)
virtual int32 getParameterCount ()
virtual tresult getParameterInfo (int32 paramIndex, ParameterInfo &info)
virtual tresult getParamStringByValue (ParamID tag, ParamValue valueNormalized, String128 string)
virtual tresult getParamValueByString (ParamID tag, TChar *string, ParamValue &valueNormalized)
virtual ParamValue normalizedParamToPlain (ParamID tag, ParamValue valueNormalized)
virtual ParamValue plainParamToNormalized (ParamID tag, ParamValue plainValue)
virtual ParamValue getParamNormalized (ParamID tag)
virtual tresult setParamNormalized (ParamID tag, ParamValue value)
virtual tresult setComponentHandler (IComponentHandler *handler)
virtual IPlugViewcreateView (FIDString)
virtual tresult setKnobMode (KnobMode mode)
virtual tresult openHelp (TBool)
virtual tresult openAboutBox (TBool)
virtual tresult initialize (FUnknown *context)
virtual tresult terminate ()
virtual tresult beginEdit (ParamID tag)
 to be called before a serie of performEdit
virtual tresult performEdit (ParamID tag, ParamValue valueNormalized)
 will inform the host about the value change
virtual tresult endEdit (ParamID tag)
 to be called after a serie of performEdit
virtual tresult startGroupEdit ()
 calls IComponentHandler2::startGroupEdit() if host supports it
virtual tresult finishGroupEdit ()
 calls IComponentHandler2::finishGroupEdit() if host supports it
virtual void editorDestroyed (EditorView *)
 called from EditorView if it was destroyed
virtual void editorAttached (EditorView *)
 called from EditorView if it was attached to a parent
virtual void editorRemoved (EditorView *)
 called from EditorView if it was removed from a parent
virtual ParametergetParameterObject (ParamID tag)
 Gets for a given tag the parameter object.
virtual tresult getParameterInfoByTag (ParamID tag, ParameterInfo &info)
 Gets for a given tag the parameter information.
virtual tresult setDirty (TBool state)
 Calls IComponentHandler2::setDirty (state) if host supports it.
virtual tresult requestOpenEditor (FIDString name=ViewType::kEditor)
 Calls IComponentHandler2::requestOpenEditor (name) if host supports it.
IComponentHandlergetComponentHandler () const

Static Public Member Functions

static KnobMode getHostKnobMode ()
 return host knob mode

Data Fields

OBJ_METHODS(EditController,
ComponentBase)
DEFINE_INTERFACES
DEF_INTERFACE(IEditController)
DEF_INTERFACE(IEditController2)
END_DEFINE_INTERFACES(ComponentBase)
REFCOUNT_METHODS(ComponentBase)
protected IComponentHandler2
componentHandler2
ParameterContainer parameters

Static Public Attributes

static KnobMode hostKnobMode = kCircularMode

Detailed Description

Default implementation for a VST 3 edit controller.

Can be used as base class for a specific controller implementation


Constructor & Destructor Documentation

EditController (  ) 

Member Function Documentation

tresult setComponentState ( IBStream state  )  [virtual]

Implements IEditController.

tresult setState ( IBStream state  )  [virtual]

Implements IEditController.

Reimplemented in SingleComponentEffect.

tresult getState ( IBStream state  )  [virtual]

Implements IEditController.

Reimplemented in SingleComponentEffect.

int32 getParameterCount (  )  [virtual]

Implements IEditController.

tresult getParameterInfo ( int32  paramIndex,
ParameterInfo info 
) [virtual]

Implements IEditController.

tresult getParamStringByValue ( ParamID  tag,
ParamValue  valueNormalized,
String128  string 
) [virtual]

Implements IEditController.

tresult getParamValueByString ( ParamID  tag,
TChar string,
ParamValue valueNormalized 
) [virtual]

Implements IEditController.

ParamValue normalizedParamToPlain ( ParamID  tag,
ParamValue  valueNormalized 
) [virtual]

Implements IEditController.

ParamValue plainParamToNormalized ( ParamID  tag,
ParamValue  plainValue 
) [virtual]

Implements IEditController.

ParamValue getParamNormalized ( ParamID  tag  )  [virtual]

Implements IEditController.

tresult setParamNormalized ( ParamID  tag,
ParamValue  value 
) [virtual]

Implements IEditController.

tresult setComponentHandler ( IComponentHandler handler  )  [virtual]

Implements IEditController.

virtual IPlugView* createView ( FIDString   )  [inline, virtual]

Implements IEditController.

virtual tresult setKnobMode ( KnobMode  mode  )  [inline, virtual]

Implements IEditController2.

virtual tresult openHelp ( TBool   )  [inline, virtual]

Implements IEditController2.

virtual tresult openAboutBox ( TBool   )  [inline, virtual]

Implements IEditController2.

tresult initialize ( FUnknown context  )  [virtual]

Reimplemented from ComponentBase.

Reimplemented in SingleComponentEffect.

tresult terminate (  )  [virtual]

Reimplemented from ComponentBase.

Reimplemented in SingleComponentEffect.

tresult beginEdit ( ParamID  tag  )  [virtual]

to be called before a serie of performEdit

tresult performEdit ( ParamID  tag,
ParamValue  valueNormalized 
) [virtual]

will inform the host about the value change

tresult endEdit ( ParamID  tag  )  [virtual]

to be called after a serie of performEdit

tresult startGroupEdit (  )  [virtual]

calls IComponentHandler2::startGroupEdit() if host supports it

tresult finishGroupEdit (  )  [virtual]

calls IComponentHandler2::finishGroupEdit() if host supports it

virtual void editorDestroyed ( EditorView  )  [inline, virtual]

called from EditorView if it was destroyed

virtual void editorAttached ( EditorView  )  [inline, virtual]

called from EditorView if it was attached to a parent

virtual void editorRemoved ( EditorView  )  [inline, virtual]

called from EditorView if it was removed from a parent

static KnobMode getHostKnobMode (  )  [inline, static]

return host knob mode

virtual Parameter* getParameterObject ( ParamID  tag  )  [inline, virtual]

Gets for a given tag the parameter object.

tresult getParameterInfoByTag ( ParamID  tag,
ParameterInfo info 
) [virtual]

Gets for a given tag the parameter information.

tresult setDirty ( TBool  state  )  [virtual]

Calls IComponentHandler2::setDirty (state) if host supports it.

tresult requestOpenEditor ( FIDString  name = ViewType::kEditor  )  [virtual]

Calls IComponentHandler2::requestOpenEditor (name) if host supports it.

IComponentHandler* getComponentHandler (  )  const [inline]

Field Documentation

OBJ_METHODS (EditController, ComponentBase) DEFINE_INTERFACES DEF_INTERFACE (IEditController) DEF_INTERFACE (IEditController2) END_DEFINE_INTERFACES (ComponentBase) REFCOUNT_METHODS(ComponentBase) protected IComponentHandler2* componentHandler2
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.